Tween

Kind of class:class
Inherits from:MovieClip
Classpath:gfx.motion.Tween
File last modified:Tuesday, 29 June 2010, 09:03:27
The Tween class adds tween methods tweenTo() and tweenFrom() to all MovieClips when the Tween.init() method is called.

Summary


Class methods
  • linearEase
    • The default ease equation.
  • init
    • Initialize the tween functions in the MovieClip class.
Instance methods
  • tweenTo
    • Tween the properties of a MovieClip specified in the props object.
  • tweenFrom
    • Tween the properties of a MovieClip from the properties specified in the props object to the current properties.
  • tweenEnd
    • End a tween immediately.

Class methods

init

static function init (
) : Boolean

Initialize the tween functions in the MovieClip class. Once initialized, any MovieClip can make use of the Tween methods.
Returns:
  • Whether Tween was initialized in the current call. If Tween was already initialized, it will return false.

linearEase

static function linearEase (
t:Number, b:Number, c:Number, d:Number) : Number

The default ease equation.

Instance methods

tweenEnd

function tweenEnd (
jumpToEnd:Boolean) : Void

End a tween immediately.
Parameters:
jumpToEnd:
Determines if the tween sets all properties to their destination values, or leaves them at their current value.

tweenFrom

function tweenFrom (
duration:Number, props:Object, ease:Function) : Void

Tween the properties of a MovieClip from the properties specified in the props object to the current properties.
Parameters:
duration:
The duration of the tween in seconds
props :
A list of properties in the MovieClip to tween from
ease :
An function to use to apply easing to the tween

tweenTo

function tweenTo (
duration:Number, props:Object, ease:Function) : Void

Tween the properties of a MovieClip specified in the props object.
Parameters:
duration:
The duration of the tween in seconds
props :
A list of properties in the MovieClip to tween
ease :
An function to use to apply easing to the tween